Skip to content

Algolio readability fix and document refinement #242

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
May 28, 2025
Merged

Algolio readability fix and document refinement #242

merged 4 commits into from
May 28, 2025

Conversation

@Saga4
Copy link
Contributor

@Saga4 Saga4 commented May 26, 2025 •
edited
Loading

Before:
image

After:
image

@Saga4 Saga4 requested a review from misrasaurabh1 May 26, 2025 23:16
@github-actions
Copy link

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Unused Imports

The imports TYPE_CHECKING, Any, and cast are added but not used in the shown diff. Consider removing unused imports to keep the code clean.

 
from typing import TYPE_CHECKING, Any, cast
Invalid Command

The documentation suggests pip install --dev codeflash, but pip does not support a --dev flag. Update to a valid installation command or clarify that it applies only to Poetry.

 
pip install --dev codeflash
Duplicate Selector

There are two separate [data-theme='dark'] blocks. Consider merging them into one to avoid redundant CSS and potential maintainability issues.

 
[data-theme='dark'] {
  /* Attempt to override Algolia's own CSS variables for the selected item's background */
  --docsearch-highlight-color: #d08e0d !important;
}

@github-actions
Copy link

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Merge duplicate CSS selectors

Merge this override into the existing [data-theme='dark'] block to avoid duplicate
selectors and ensure the variable is applied consistently. Drop the duplicate block
and place the --docsearch-highlight-color line alongside your other theme variables.

docs/src/css/custom.css [32-35]

 [data-theme='dark'] {
-  /* Attempt to override Algolia's own CSS variables for the selected item's background */
-  --docsearch-highlight-color: #d08e0d !important;
+  --ifm-color-primary: #FFD227;
+  --ifm-color-primary-dark: #FFA000;
+  --ifm-color-primary-darker: #FF8F00;
+  --ifm-color-primary-darkest: #FF6F00;
+  --ifm-color-primary-light: #FFD54F;
+  --ifm-color-primary-lighter: #FFE082;
+  --ifm-color-primary-lightest: #FFECB3;
+  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
+  --docsearch-highlight-color: #d08e0d;
 }
Suggestion importance[1-10]: 6

__

Why: Combining the duplicate [data-theme='dark'] blocks removes redundancy and ensures the --docsearch-highlight-color variable is applied alongside the other theme settings.

Low
Remove invalid pip flag

The --dev flag is not supported by pip and will error; to install Codeflash as a
development dependency, either add it to your dev-requirements file or simply run
pip install codeflash. Removing the invalid flag will prevent confusion.

docs/docs/getting-started/local-installation.md [45-47]

 ```bash
-pip install --dev codeflash
+pip install codeflash
<details><summary>Suggestion importance[1-10]: 5</summary>

__

Why: The `--dev` flag is not supported by `pip install` and will error, so updating the docs to use a valid command improves accuracy.


</details></details></td><td align=center>Low

</td></tr><tr><td>



<details><summary>Remove CSS !important</summary>

___


**Avoid using <code>!important</code> by targeting the specific Algolia suggestion highlight <br>selector for dark mode. This prevents unintended global overrides and keeps <br>specificity clear.**

[docs/src/css/custom.css [32-35]](https://github.com/codeflash-ai/codeflash/pull/242/files#diff-bba10eb4bb3b6b325f2e0cd219ae2fbd90e095dfb458f024d96f8406dff3ae5eR32-R35)

```diff
-[data-theme='dark'] {
-  --docsearch-highlight-color: #d08e0d !important;
+[data-theme='dark'] .ds-suggestion--highlighted {
+  background-color: #d08e0d;
 }
Suggestion importance[1-10]: 5

__

Why: Targeting the specific .ds-suggestion--highlighted selector removes the need for !important and maintains proper CSS specificity.

Low

Saga4
Saga4 commented May 26, 2025
View reviewed changes
codeflash/cli_cmds/cmd_init.py Outdated
module_root: str
tests_root: str
benchmarks_root: Union[str, None]
benchmarks_root: str | None
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to check whats causing this change on saving in local.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you might have 'format on save' on in your IDE

misrasaurabh1
misrasaurabh1 reviewed May 26, 2025
View reviewed changes
misrasaurabh1
misrasaurabh1 reviewed May 26, 2025
View reviewed changes
@Saga4 Saga4 requested a review from misrasaurabh1 May 27, 2025 07:06
@Saga4 Saga4 changed the title Algolio reability fix and document refinement Algolio readability fix and document refinement May 27, 2025
misrasaurabh1
misrasaurabh1 previously approved these changes May 28, 2025
View reviewed changes
Copy link
Contributor

@misrasaurabh1 misrasaurabh1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

revert the benchmarks_root piece. Maybe add an ignore flag to it.

@Saga4 Saga4 merged commit 36dbdff into main May 28, 2025
14 of 16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@aseembits93 aseembits93 aseembits93 left review comments

@misrasaurabh1 misrasaurabh1 misrasaurabh1 left review comments

Assignees

No one assigned

Labels

Review effort 2/5

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Saga4 @misrasaurabh1 @aseembits93